home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / olrdrs / yarn_068.zip / YARN.DOC < prev    next >
Text File  |  1994-06-22  |  31KB  |  911 lines
  1.  
  2.  
  3. Yarn User Manual - version 0.68                                                
  4.  
  5.  
  6.  
  7.      Yarn - offline news storage and reading system
  8.  
  9.      Copyright (c) 1994 Chin Huang
  10.  
  11.      Permission to copy and distribute this material for any purpose and
  12.      without fee is hereby granted, provided that the above copyright notice
  13.      and this permission notice appear in all copies.  THE AUTHOR MAKES NO
  14.      REPRESENTATIONS ABOUT THE ACCURACY OR SUITABILITY OF THIS MATERIAL FOR ANY
  15.      PURPOSE.  IT IS PROVIDED "AS IS", WITHOUT ANY EXPRESS OR IMPLIED
  16.      WARRANTIES.  THE AUTHOR WILL ASSUME NO LIABILITY FOR DAMAGES EITHER FROM
  17.      THE DIRECT USE OF THIS PRODUCT OR AS A CONSEQUENCE OF THE USE OF THIS
  18.      PRODUCT.
  19.  
  20.  
  21.                                  INTRODUCTION
  22.  
  23.      Yarn is a suite of programs for your personal computer, used to store and
  24.      read USENET news downloaded from a USENET host.
  25.  
  26. FEATURES
  27.  
  28.      -  An import program inserts USENET articles into a "news base" from
  29.         Simple Offline USENET Packet (SOUP) format.  A mail filter moves
  30.         incoming mail to specific folders or deletes incoming mail based on a
  31.         set of user defined rules.
  32.  
  33.      -  For each newsgroup, you specify the number of days to keep articles,
  34.         after which, an expire program deletes them.  However, articles
  35.         containing an Expires: header are deleted on the date specified in the
  36.         header.
  37.  
  38.      -  The news base stores only one copy of a cross-posted article.  The news
  39.         base implementation stores multiple articles per file.
  40.  
  41.      -  The Yarn news reader presents articles in threads arranged by Message-
  42.         ID and References.  The reader program generates SOUP reply packets.
  43.  
  44.      -  Multiple users are supported by storing separate configuration files
  45.         for each user.
  46.  
  47. SYSTEM REQUIREMENTS
  48.  
  49.      -  MS-DOS 3.0 or higher
  50.  
  51.      -  80386 compatible CPU or better to run the 32-bit DOS extender version
  52.         of the reader program.  A real mode version of the reader is also
  53.         included for non-386 systems.
  54.  
  55.      -  a lot of hard disk storage, depending on how much news you want to
  56.         keep.  For example, the author subscribes to 120 newsgroups including
  57.         some binaries and sources groups, keeping most articles for 7 days.
  58.         The amount of disk space used is 40 megabytes.
  59.  
  60.  
  61.  
  62.  
  63.  
  64.                                                                               1
  65.  
  66.  
  67.  
  68. Yarn User Manual - version 0.68                                                
  69.  
  70.  
  71.                                  INSTALLATION
  72.  
  73. INSTALL YARN DIRECTORY
  74.  
  75.      Unpack the files from the Yarn package into a directory.  Run the command
  76.  
  77.           install [drive:]directory
  78.  
  79.      where [drive:]directory specifies where to install the Yarn data
  80.      directory.  This directory is created if it doesn't already exist.  Choose
  81.      a disk drive with a lot of free space because the news base will be stored
  82.      here.  In this document, this directory will be called the $YARN
  83.      directory.
  84.  
  85. SET UP USER DIRECTORY
  86.  
  87.      To set up a user directory where Yarn will store your user information,
  88.      run the command
  89.  
  90.           adduser
  91.  
  92.      A form appears in which you fill in the required user information.
  93.  
  94.      + Add User ------------------------------------------------------------+
  95.      |                                                                      |
  96.      |    Home directory: C:\JIM                                            |
  97.      |                                                                      |
  98.      |           User ID: jsmith                                            |
  99.      |                                                                      |
  100.      |       Host system: netcom.com                                        |
  101.      |                                                                      |
  102.      |  User's full name: Jim Smith                                         |
  103.      |                                                                      |
  104.      |    Editor program: edit                                              |
  105.      |                                                                      |
  106.      | Reply packet file: C:\UPLOAD\IOXR.ZIP                                |
  107.      |                                                                      |
  108.      +----------------------------------------------------------------------+
  109.  
  110.      Home directory
  111.           Specify the directory where Yarn will store your user information.
  112.           This directory is created if it doesn't already exist.  In this
  113.           document, this directory will be called the $HOME directory.
  114.  
  115.      User ID
  116.           Set this to your login name on the host from which you download and
  117.           upload USENET news.
  118.  
  119.      Host system
  120.           Set this to the full domain name of your host.
  121.  
  122.      User's full name
  123.           Set this to your full name.  This is the name that appears in
  124.           parentheses on the From: header in messages you send.
  125.  
  126.  
  127.  
  128.  
  129.                                                                               2
  130.  
  131.  
  132.  
  133. Yarn User Manual - version 0.68                                                
  134.  
  135.  
  136.      Editor program
  137.           Set the name of the editor program to run when you send messages.
  138.           The program must be in your PATH.
  139.  
  140.      Reply packet file
  141.           Specify the full path of the SOUP reply packet file where your
  142.           outgoing messages are stored.  If the reply packet file does not
  143.           exist, it is created when you post an article or send a mail message
  144.           from the reader program.  When you exit the reader program, the reply
  145.           packet is ready to upload to your host.
  146.  
  147.      The program writes the user information to a configuration file named
  148.      $HOME\yarn\config.  This document refers to other configuration settings
  149.      also stored in this file.  If you want to change those settings, you have
  150.      to edit the configuration file with a text editor.
  151.  
  152. SET TIME ZONE
  153.  
  154.      Set the environment variable TZ to your time zone.  The format of the TZ
  155.      string is
  156.  
  157.           zzz[+/-]h[h][ddd]
  158.  
  159.      zzz is a three character field representing the name of the time zone.
  160.  
  161.      [+/-]h[h] is an optionally signed number representing the local time
  162.      zone's difference from Greenwich Mean Time (GMT) in hours.  Positive
  163.      numbers adjust westward from GMT.  Negative numbers adjust eastward from
  164.      GMT.
  165.  
  166.      ddd is an optional three character field that represents the name of the
  167.      local time zone's daylight saving time.
  168.  
  169.      If no TZ environment variable is set, a default TZ=EST5EDT is assumed.
  170.  
  171. UPDATE SYSTEM FILES
  172.  
  173.      Put these SET commands in your AUTOEXEC.BAT file to ensure the environment
  174.      settings persist after the next time you reboot your system.  (If you are
  175.      installing Yarn for OS/2, put the SET commands in your CONFIG.SYS file
  176.      instead.)  Use the settings determined above for the values appearing to
  177.      the right of the equal signs.
  178.  
  179.           SET YARN=$YARN
  180.           SET HOME=$HOME
  181.           SET TZ=EST5EDT
  182.  
  183.  
  184. USING THE MAIL FILTER
  185.  
  186.      The mail filter looks at incoming mail messages and process the messages
  187.      based on a set of rules you define.  You can set up a rule that
  188.      automatically moves messages you receive from a mailing list to a specific
  189.      folder.  Or, you can automatically delete messages from a specific user so
  190.      that you don't even see messages from that user.
  191.  
  192.  
  193.  
  194.                                                                               3
  195.  
  196.  
  197.  
  198. Yarn User Manual - version 0.68                                                
  199.  
  200.  
  201.      Run the filter program to set up the filter rules.  A list of filter rules
  202.      appears.  To add a filter rule, press the [Ins] key.  The mail rule form
  203.      appears.
  204.  
  205.      + Mail Rule ----------------------------------------------------------+
  206.      |                                                                     |
  207.      | Rule name: Yarn M